cs-credits-sapi
📘 Documentación de la API - CS Credits System API (SAPI)
Esta sección proporciona el significado de los atributos incluidos en la API.
🗂️ Información Base
- Título de la API: API del Sistema de Créditos CS (SAPI)
- Versión: 1.0.0
- URL Base: https://cs-credits-sapi.cloudhub.com/
🔑 CLAVES API
"Authorization": "Bearer {{API_KEY}}" - Atributo definido en el Header de la solicitud.
- Tipo: String
- Longitud: Mínimo 36 caracteres, máximo 37 caracteres
- Descripción: Token de autenticación requerido para acceder a la API.
"client_id": "{{CLIENT_ID}}" - Atributo definido en el Header de la solicitud.
- Tipo: String
- Longitud: Mínimo 32 caracteres, máximo 36 caracteres
- Descripción: Identificador único del cliente para autenticar la solicitud.
NOTA: Es importante tener estas CLAVES API para realizar cualquier solicitud a nuestros servicios.
📄 Verificar Estado (POST /subscriptions/check-status)
"idRequest"
- Tipo: Número
- Descripción: Identificador único para la solicitud de seguro de crédito.
- Ejemplo:
255025
"status"
- Tipo: String
- Descripción: El estado actual del seguro de crédito.
- Valores Permitidos:
pending,approved,rejected
✏️ Actualizar Estado (PUT /subscriptions/{idRequest})
"idRequest"
- Tipo: Número
- Descripción: Identificador único para la solicitud de seguro de crédito (parámetro de ruta).
- Ejemplo:
255025
"status"
- Tipo: String
- Descripción: Nuevo estado a actualizar para la solicitud.
- Valores Permitidos:
pending,approved,rejected
"comments"
- Tipo: String
- Descripción: Comentarios opcionales sobre la actualización del estado.
- Longitud Máxima: 250 caracteres
🗂️ Parámetros Comunes
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
client_id | string | Identificador único para clientes API | ✅ |
Authorization | string | Token Bearer para acceso seguro | ✅ |
idRequest | number | ID único para solicitud de seguro | ✅ |
status | string | Estado de la solicitud de seguro | ✅ (para solicitudes PUT) |
comments | string | Notas o comentarios adicionales | Opcional |
🔐 Esquemas de Seguridad
Aplicación de Client ID
| Campo | Tipo | Requerido | Longitud (caracteres) | RegEx |
|---|---|---|---|---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud (caracteres) | RegEx |
|---|---|---|---|---|
Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error Comunes
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 400 | Solicitud Incorrecta | Verificar la estructura de la solicitud. |
| 401 | No Autorizado | Revisar las credenciales de autenticación. |
| 404 | No Encontrado | Asegurar que el endpoint sea correcto. |
| 500 | Error Interno del Servidor | Intentar más tarde o contactar soporte. |
📞 Soporte
Para cualquier pregunta o problema, por favor contacta al equipo de soporte de la API COORDINACIÓN DESARROLLO DE SERVICIOS Y APLICACIONES DE INTEGRACIONES.
Notas
- Documentación ajustada en Agosto 2025.
- Para información adicional, contactar: epalma@fgs.co